Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update work item template #2818

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update work item template #2818

wants to merge 5 commits into from

Conversation

cptartur
Copy link
Member

Closes #2810

Introduced changes

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

@cptartur cptartur marked this pull request as ready for review January 8, 2025 08:53
.github/ISSUE_TEMPLATE/work_item.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/work_item.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/work_item.yml Outdated Show resolved Hide resolved
- other (describe below)
label: Current State
description: Describe the current state and state the problem
placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.
placeholder: e.g. Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder will be displayed as a semi-opaque text in the text box that will disappear once user starts typing. I don't thing e.g. is necessary in that case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine, so let's remove it from all placeholders for consistency

description: Describe the issue here.
label: Correct State
description: Briefly describe the correct state
placeholder: `print_a` should magically detect if user wants to print to stdout or a printer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
placeholder: `print_a` should magically detect if user wants to print to stdout or a printer.
placeholder: e.g. `print_a` should magically detect if user wants to print to stdout or a printer.

attributes:
label: Additional Context
description: Provide additional context on the desired state.
placeholder: E.g. if we can detect any printers in local network it might indicate that user wants to print to it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
placeholder: E.g. if we can detect any printers in local network it might indicate that user wants to print to it.
placeholder: e.g. If we can detect any printers in local network it might indicate that user wants to print to it.

Copy link
Collaborator

@kkawula kkawula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cptartur
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New issue template
3 participants